fun CloseConfirmationDialog(_: Nothing = nothing, modifier: Modifier = Modifier, icon: @Composable () -> Unit? = { Icon(imageVector = IconPack.CloudAlertOutline, contentDescription = null) }, title: @Composable () -> Unit? = { Text(text = stringResource(R.string.ly_img_editor_dialog_close_confirm_title)) }, text: @Composable () -> Unit? = { Text(text = stringResource(R.string.ly_img_editor_dialog_close_confirm_text)) }, onDismissRequest: () -> Unit = { showCloseConfirmationDialog = false }, confirmButton: @Composable () -> Unit = { TextButton( onClick = { onDismissRequest() editorContext.eventHandler.send(EditorEvent.CloseEditor()) }, ) { Text(stringResource(R.string.ly_img_editor_dialog_close_confirm_button_confirm)) } }, dismissButton: @Composable () -> Unit? = { TextButton( onClick = onDismissRequest, ) { Text(stringResource(R.string.ly_img_editor_dialog_close_confirm_button_dismiss)) } }, properties: DialogProperties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false), __: Nothing = nothing)

A helper composable function for displaying a confirmation dialog when closing the editor.

ErrorDialog

@Composable

fun ErrorDialog(_: Nothing = nothing, throwable: Throwable, modifier: Modifier = Modifier, icon: @Composable () -> Unit? = null, title: @Composable () -> Unit? = { Text(text = stringResource(R.string.ly_img_editor_dialog_error_title)) }, text: @Composable () -> Unit? = { Text( text = (throwable as? EngineException)?.getDisplayMessage(LocalContext.current) ?: throwable.message ?: "", ) }, confirmButton: @Composable () -> Unit = { TextButton( onClick = { error = null editorContext.eventHandler.send(EditorEvent.CloseEditor(throwable)) }, ) { Text(stringResource(R.string.ly_img_editor_dialog_error_confirm_text)) } }, dismissButton: @Composable () -> Unit? = null, onDismissRequest: () -> Unit = {}, properties: DialogProperties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false), __: Nothing = nothing)

A helper composable function for displaying a dialog when the editor captures a throwable.

export

suspend fun export(_: Nothing = nothing, block: DesignBlock = requireNotNull(editorContext.engine.scene.get()), mimeType: MimeType = MimeType.PDF, preExport: suspend Engine.() -> Unit = { // The engine instance is background engine here and has nothing to do with editorContext.engine. this.scene.getPages().forEach { this.block.setScopeEnabled(it, key = "layer/visibility", enabled = true) this.block.setVisible(it, visible = true) } }): ByteBuffer

A helper function that exports the block.

getOrLoadScene

suspend fun getOrLoadScene(_: Nothing = nothing, sceneUri: Uri): DesignBlock

A helper function that returns the currently active scene or creates it from the given sceneUri.

@Composable

fun Loading(_: Nothing = nothing, onDismissRequest: () -> Unit = {}, properties: DialogProperties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false), content: @Composable () -> Unit = { CircularProgressIndicator( modifier = Modifier.testTag("MainLoading"), color = MaterialTheme.colorScheme.onPrimary, ) })

A helper composable function for displaying a loading overlay.

NoInternetDialog

@Composable

fun NoInternetDialog(_: Nothing = nothing, modifier: Modifier = Modifier, icon: @Composable () -> Unit? = { Icon(imageVector = IconPack.WifiCancel, contentDescription = null) }, title: @Composable () -> Unit? = { Text(text = stringResource(R.string.ly_img_editor_dialog_no_internet_title)) }, text: @Composable () -> Unit? = { Text(text = stringResource(R.string.ly_img_editor_dialog_no_internet_text)) }, confirmButton: @Composable () -> Unit = { TextButton( onClick = { showLoading = false editorContext.eventHandler.send(EditorEvent.CloseEditor(EditorException(EditorException.Code.NO_INTERNET))) }, ) { Text(stringResource(R.string.ly_img_editor_dialog_no_internet_button_confirm)) } }, dismissButton: @Composable () -> Unit? = null, onDismissRequest: () -> Unit = {}, properties: DialogProperties = DialogProperties(dismissOnBackPress = false, dismissOnClickOutside = false), __: Nothing = nothing)

A helper composable function for displaying a dialog when there is not internet.

observeEditorEditMode

suspend fun observeEditorEditMode(_: Nothing = nothing, extraInsets: (String) -> Insets = { editMode -> Insets(value = if (editMode == "Crop") 24.dp else 16.dp) }, callback: suspend (String) -> Unit = {})

A helper function that observes the edit mode of the the editor and sets extra canvas insets.

Overlay

@Composable

fun Overlay(_: Nothing = nothing, backHandler: @Composable () -> Unit = { val isBackHandlerEnabled by remember { combine( editorContext.engine.editor.onHistoryUpdatedWithKind().map { editorContext.engine.editor.canUndo() }, editorContext.state.map { it.isBackHandlerEnabled }, ) { canUndo, isBackHandlerEnabled -> canUndo && !isBackHandlerEnabled } }.collectAsState(false) BackHandler(isBackHandlerEnabled) { editorContext.eventHandler.send(EditorEvent.OnClose()) } }, loading: @Composable () -> Unit = { if (showLoading) { Loading() } }, errorDialog: @Composable () -> Unit = { this@BasicConfigurationBuilder.error?.let { ErrorDialog(throwable = it) } }, closeConfirmationDialog: @Composable () -> Unit = { if (showCloseConfirmationDialog) { CloseConfirmationDialog() } }, __: Nothing = nothing)

A helper function that renders the overlay based on showLoading, showCloseConfirmationDialog and error state objects.

shareFile

fun shareFile(_: Nothing = nothing, authority: String = ".ly.img.editor.fileprovider", file: File, mimeType: MimeType)

A helper function that opens a system dialog to share the file. Note that the uri of the file is resolved on a background thread, therefore the system dialog is opened asynchronously. If the uri resolution fails, the error state is set instead of throwing.

shareUri

fun shareUri(_: Nothing = nothing, uri: Uri, mimeType: MimeType)

A helper function that opens a system dialog to share the uri.

showConfirmationOrCloseEditor

fun showConfirmationOrCloseEditor()

A helper function that:

writeToFile

suspend fun writeToFile(_: Nothing = nothing, byteBuffer: ByteBuffer, mimeType: MimeType = MimeType.PDF, file: suspend () -> File = { val extension = "." + mimeType.key.split("/").last() File.createTempFile(UUID.randomUUID().toString(), extension) }): File

A helper function that writes byteBuffer into a file.